FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.7.16  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package nhs.england.rad#current (47 ms)

Package nhs.england.rad
Type CapabilityStatement
Id Id
FHIR Version R4
Source https://fhir.nhs.uk/England/RAD/https://build.fhir.org/ig/Interop-NWEngland/IHE-RAD/CapabilityStatement-FindAndRetrieveImagingReports.html
Url https://fhir.nhs.uk/England/RAD/CapabilityStatement/FindAndRetrieveImagingReports
Version 0.0.1-current
Status draft
Date 2024-04-20
Name FindAndRetrieveImagingReports
Title Find and Retrieve Imaging Reports
Experimental False
Realm uk
Description This is a capture of requirements coming from this project. Although this is classed here as a [Document Repository](ActorDefinition-DocumentRepository.html), it may often be implemented as a [Clinical Data Repository](ActorDefinition-ClinicalDataRepository.html) and so the actual API may be more expressive e.g. [IHE Query for Existing Data for Mobile (QEDm)](https://build.fhir.org/ig/IHE/QEDm/branches/master/PCC-44.html#234441214-diagnostic-reports-option-search-parameters).
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
ImagingReport Imaging Report (FHIR DiagnosticReport)


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement FindAndRetrieveImagingReports

Find and Retrieve Imaging Reports

  • Implementation Guide Version: 0.0.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-04-20
  • Published by: NHS England

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Security

Recommend ATNA/NHS England Audits, encouraged IHE-IUA plus SMART-on-FHIR

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
DiagnosticReporthttps://fhir.nhs.uk/England/RAD/StructureDefinition/ImagingReport
Additional supported profiles:
  UK Core DiagnosticReport
yy_id

Resource Conformance: supported DiagnosticReport

Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core DiagnosticReport

Interaction summary
  • Supports read, search-type.

Documentation

Read

GET /DiagnosticReport/{id}

Example

GET /DiagnosticReport/ABCD

Example API response:

Search

GET /DiagnosticReport?{parameters}

Example

GET /DiagnosticReport?_id=ABCD

Example response:

Implementers SHALL also conform to UKCore-DocumentReference and conformance to all profiles SHOULD be tested via FHIR Validation.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

logical identifier of resource

 

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "FindAndRetrieveImagingReports",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement FindAndRetrieveImagingReports</b></p><a name=\"FindAndRetrieveImagingReports\"> </a><a name=\"hcFindAndRetrieveImagingReports\"> </a><a name=\"FindAndRetrieveImagingReports-en-GB\"> </a><h2 id=\"title\">Find and Retrieve Imaging Reports</h2><ul><li>Implementation Guide Version: 0.0.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-04-20 </li><li>Published by: NHS England </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"subdomain-audits.html\">ATNA/NHS England Audits</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> plus <a href=\"https://www.hl7.org/fhir/smart-app-launch/\">SMART-on-FHIR</a></p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#DiagnosticReport1-1\">DiagnosticReport</a></td><td><a href=\"StructureDefinition-ImagingReport.html\">https://fhir.nhs.uk/England/RAD/StructureDefinition/ImagingReport</a><br/><em>Additional supported profiles:</em><br/>��<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&amp;canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport\">UK Core DiagnosticReport</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DiagnosticReport1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>DiagnosticReport</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ImagingReport.html\">Imaging Report (FHIR DiagnosticReport)</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&amp;canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport\">UK Core DiagnosticReport</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><h3>Read</h3>\n<pre><code>GET /DiagnosticReport/{id}\n</code></pre>\n<h4>Example</h4>\n<pre><code>GET /DiagnosticReport/ABCD\n</code></pre>\n<p>Example API response:</p>\n<ul>\n<li><a href=\"DiagnosticReport-DiagnosticReportRadiologyRCR.html\">Imaging Report - Royal College of Radiologist</a></li>\n<li><a href=\"DiagnosticReport-DiagnosticReportRadiologyPlatforms.html\">Imaging Report - NHS England Alpha Specification</a></li>\n</ul>\n<h3>Search</h3>\n<pre><code>GET /DiagnosticReport?{parameters}\n</code></pre>\n<h4>Example</h4>\n<pre><code>GET /DiagnosticReport?_id=ABCD\n</code></pre>\n<p>Example response:</p>\n<ul>\n<li><a href=\"Bundle-NRLSearchDiagnosticReports.html\">Document Reference Search Results NRL</a></li>\n</ul>\n<p>Implementers <strong>SHALL</strong> also conform to <a href=\"https://simplifier.net/hl7fhirukcorer4/ukcore-documentreference\">UKCore-DocumentReference</a> and conformance to all profiles <strong>SHOULD</strong> be tested via <a href=\"https://hl7.org/fhir/R4/validation.html\">FHIR Validation</a>.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>logical identifier of resource</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
  },
  "url" : "https://fhir.nhs.uk/England/RAD/CapabilityStatement/FindAndRetrieveImagingReports",
  "version" : "0.0.1-current",
  "name" : " FindAndRetrieveImagingReports",
  "title" : "Find and Retrieve Imaging Reports",
  "status" : "draft",
  "experimental" : false,
  "date" : "2024-04-20",
  "publisher" : "NHS England",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    },
    {
      "name" : "NHS England",
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    }
  ],
  "description" : "This is a capture of requirements coming from this project.\n\nAlthough this is classed here as a [Document Repository](ActorDefinition-DocumentRepository.html), it may often be implemented as a [Clinical Data Repository](ActorDefinition-ClinicalDataRepository.html) and so the actual API may be more expressive e.g. [IHE Query for Existing Data for Mobile (QEDm)](https://build.fhir.org/ig/IHE/QEDm/branches/master/PCC-44.html#234441214-diagnostic-reports-option-search-parameters).",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "GB",
          "display" : "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "security" : {
        "description" : "Recommend [ATNA/NHS England Audits](subdomain-audits.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) plus [SMART-on-FHIR](https://www.hl7.org/fhir/smart-app-launch/)"
      },
      "resource" : [
        {
          "type" : "DiagnosticReport",
          "profile" : "https://fhir.nhs.uk/England/RAD/StructureDefinition/ImagingReport",
          "supportedProfile" : [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport"
          ],
          "documentation" : " ### Read\n\n```\nGET /DiagnosticReport/{id}\n```\n\n#### Example\n\n```\nGET /DiagnosticReport/ABCD\n```\n\nExample API response:\n- [Imaging Report - Royal College of Radiologist](DiagnosticReport-DiagnosticReportRadiologyRCR.html)\n- [Imaging Report - NHS England Alpha Specification](DiagnosticReport-DiagnosticReportRadiologyPlatforms.html)\n\n### Search\n\n```\nGET /DiagnosticReport?{parameters}\n```\n\n#### Example\n\n```\nGET /DiagnosticReport?_id=ABCD\n```\n\nExample response:\n- [Document Reference Search Results NRL](Bundle-NRLSearchDiagnosticReports.html)\n\nImplementers **SHALL** also conform to [UKCore-DocumentReference](https://simplifier.net/hl7fhirukcorer4/ukcore-documentreference) and conformance to all profiles **SHOULD** be tested via [FHIR Validation](https://hl7.org/fhir/R4/validation.html).\n",
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "logical identifier of resource"
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.